<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xiltimer: XTimerTag Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xiltimer
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('struct_x_timer_tag.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">XTimerTag Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Structure to the XFpga instance.
 <a href="struct_x_timer_tag.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a1596156ea70229b14ebdb8776e890fea"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_timer_tag.html#a1596156ea70229b14ebdb8776e890fea">XTimer_ModifyInterval</a> )(struct <a class="el" href="struct_x_timer_tag.html">XTimerTag</a> *InstancePtr, u32 delay, <a class="el" href="xiltimer_8h.html#ac78bbfcf92781c4163433b9234ca5adb">XTimer_DelayType</a> Delaytype)</td></tr>
<tr class="memdesc:a1596156ea70229b14ebdb8776e890fea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modifies the timer interval.  <a href="#a1596156ea70229b14ebdb8776e890fea">More...</a><br/></td></tr>
<tr class="separator:a1596156ea70229b14ebdb8776e890fea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a789426610fee231cacc16560c831bc42"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_timer_tag.html#a789426610fee231cacc16560c831bc42">XTimer_TickIntrHandler</a> )(struct <a class="el" href="struct_x_timer_tag.html">XTimerTag</a> *InstancePtr, u8 Priority)</td></tr>
<tr class="memdesc:a789426610fee231cacc16560c831bc42"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tick interrupt handler.  <a href="#a789426610fee231cacc16560c831bc42">More...</a><br/></td></tr>
<tr class="separator:a789426610fee231cacc16560c831bc42"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa0931e9c88867714880e5d22aeca89b0"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_timer_tag.html#aa0931e9c88867714880e5d22aeca89b0">XTimer_TickInterval</a> )(struct <a class="el" href="struct_x_timer_tag.html">XTimerTag</a> *InstancePtr, u32 Delay)</td></tr>
<tr class="memdesc:aa0931e9c88867714880e5d22aeca89b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures the tick interval.  <a href="#aa0931e9c88867714880e5d22aeca89b0">More...</a><br/></td></tr>
<tr class="separator:aa0931e9c88867714880e5d22aeca89b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08c800b5458109d2b26ad3b8b82d2582"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_timer_tag.html#a08c800b5458109d2b26ad3b8b82d2582">XSleepTimer_Stop</a> )(struct <a class="el" href="struct_x_timer_tag.html">XTimerTag</a> *InstancePtr)</td></tr>
<tr class="memdesc:a08c800b5458109d2b26ad3b8b82d2582"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stops the sleep timer.  <a href="#a08c800b5458109d2b26ad3b8b82d2582">More...</a><br/></td></tr>
<tr class="separator:a08c800b5458109d2b26ad3b8b82d2582"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6b45555673e3e0e07a63a43625dea63"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_timer_tag.html#aa6b45555673e3e0e07a63a43625dea63">XTickTimer_Stop</a> )(struct <a class="el" href="struct_x_timer_tag.html">XTimerTag</a> *InstancePtr)</td></tr>
<tr class="memdesc:aa6b45555673e3e0e07a63a43625dea63"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stops the tick timer.  <a href="#aa6b45555673e3e0e07a63a43625dea63">More...</a><br/></td></tr>
<tr class="separator:aa6b45555673e3e0e07a63a43625dea63"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65213463c513915b2057907b0548a7a1"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_timer_tag.html#a65213463c513915b2057907b0548a7a1">XTickTimer_ClearInterrupt</a> )(struct <a class="el" href="struct_x_timer_tag.html">XTimerTag</a> *InstancePtr)</td></tr>
<tr class="memdesc:a65213463c513915b2057907b0548a7a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears the Tick timer interrupt status.  <a href="#a65213463c513915b2057907b0548a7a1">More...</a><br/></td></tr>
<tr class="separator:a65213463c513915b2057907b0548a7a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e4c875a87fc8e4158293010a729bb2f"><td class="memItemLeft" align="right" valign="top">XTimer_TickHandler&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_timer_tag.html#a3e4c875a87fc8e4158293010a729bb2f">Handler</a></td></tr>
<tr class="memdesc:a3e4c875a87fc8e4158293010a729bb2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback function.  <a href="#a3e4c875a87fc8e4158293010a729bb2f">More...</a><br/></td></tr>
<tr class="separator:a3e4c875a87fc8e4158293010a729bb2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ba807967063169be63cde744354d0a8"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_timer_tag.html#a5ba807967063169be63cde744354d0a8">CallBackRef</a></td></tr>
<tr class="memdesc:a5ba807967063169be63cde744354d0a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback reference for handler.  <a href="#a5ba807967063169be63cde744354d0a8">More...</a><br/></td></tr>
<tr class="separator:a5ba807967063169be63cde744354d0a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Structure to the XFpga instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">XTimer_ModifyInterval</td><td>Modifies the timer interval </td></tr>
    <tr><td class="paramname">XTimer_TickIntrHandler</td><td>Tick interrupt handler </td></tr>
    <tr><td class="paramname">XTimer_TickInterval</td><td>Configures the tick interval </td></tr>
    <tr><td class="paramname">XSleepTimer_Stop</td><td>Stops the sleep timer </td></tr>
    <tr><td class="paramname">XTickTimer_Stop</td><td>Stops the tick timer </td></tr>
    <tr><td class="paramname">XTickTimer_ClearInterrupt</td><td>Clears the Tick timer interrupt status </td></tr>
    <tr><td class="paramname">Handler</td><td>Tick Handler </td></tr>
    <tr><td class="paramname">CallBackRef</td><td>Callback reference for handler </td></tr>
    <tr><td class="paramname">AxiTimer_SleepInst</td><td>Sleep Instance for AxiTimer </td></tr>
    <tr><td class="paramname">AxiTimer_TickInst</td><td>Tick Instance for AxiTimer </td></tr>
    <tr><td class="paramname">TtcPs_SleepInst</td><td>Sleep Instance for TTCPS </td></tr>
    <tr><td class="paramname">TtcPs_TickInst</td><td>Tick Instance for TTCPS </td></tr>
    <tr><td class="paramname">ScuTimer_SleepInst</td><td>Sleep Instance for Scutimer </td></tr>
    <tr><td class="paramname">ScuTimer_TickInst</td><td>Tick Instance for Scutimer </td></tr>
  </table>
  </dd>
</dl>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a5ba807967063169be63cde744354d0a8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* XTimerTag::CallBackRef</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Callback reference for handler. </p>

<p>Referenced by <a class="el" href="group__xiltimer__api.html#ga6395671177518353e3ab5ded9609eb1e">XTimer_SetHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="a3e4c875a87fc8e4158293010a729bb2f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XTimer_TickHandler XTimerTag::Handler</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Callback function. </p>

<p>Referenced by <a class="el" href="group__xiltimer__api.html#ga6395671177518353e3ab5ded9609eb1e">XTimer_SetHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="a08c800b5458109d2b26ad3b8b82d2582"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void(* XTimerTag::XSleepTimer_Stop)(struct <a class="el" href="struct_x_timer_tag.html">XTimerTag</a> *InstancePtr)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Stops the sleep timer. </p>

</div>
</div>
<a class="anchor" id="a65213463c513915b2057907b0548a7a1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void(* XTimerTag::XTickTimer_ClearInterrupt)(struct <a class="el" href="struct_x_timer_tag.html">XTimerTag</a> *InstancePtr)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Clears the Tick timer interrupt status. </p>

<p>Referenced by <a class="el" href="group__xiltimer__api.html#ga30d16ade92d9b5d61797f69f06bdd7bb">XTimer_ClearTickInterrupt()</a>.</p>

</div>
</div>
<a class="anchor" id="aa6b45555673e3e0e07a63a43625dea63"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void(* XTimerTag::XTickTimer_Stop)(struct <a class="el" href="struct_x_timer_tag.html">XTimerTag</a> *InstancePtr)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Stops the tick timer. </p>

</div>
</div>
<a class="anchor" id="a1596156ea70229b14ebdb8776e890fea"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void(* XTimerTag::XTimer_ModifyInterval)(struct <a class="el" href="struct_x_timer_tag.html">XTimerTag</a> *InstancePtr, u32 delay, <a class="el" href="xiltimer_8h.html#ac78bbfcf92781c4163433b9234ca5adb">XTimer_DelayType</a> Delaytype)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Modifies the timer interval. </p>

<p>Referenced by <a class="el" href="group__xiltimer__api.html#ga3bf4c88807bba962c75976fed3c217d9">XilTimer_Sleep()</a>.</p>

</div>
</div>
<a class="anchor" id="aa0931e9c88867714880e5d22aeca89b0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void(* XTimerTag::XTimer_TickInterval)(struct <a class="el" href="struct_x_timer_tag.html">XTimerTag</a> *InstancePtr, u32 Delay)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Configures the tick interval. </p>

<p>Referenced by <a class="el" href="group__xiltimer__api.html#gac2d61518eafb79f1bad01cecb9503d6c">XTimer_SetInterval()</a>.</p>

</div>
</div>
<a class="anchor" id="a789426610fee231cacc16560c831bc42"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void(* XTimerTag::XTimer_TickIntrHandler)(struct <a class="el" href="struct_x_timer_tag.html">XTimerTag</a> *InstancePtr, u8 Priority)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Tick interrupt handler. </p>

<p>Referenced by <a class="el" href="group__xiltimer__api.html#ga6395671177518353e3ab5ded9609eb1e">XTimer_SetHandler()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
